# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your MultiworldGG options are valid at this site:
#        https://multiworld.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Pinball FX3 Template

game: Pinball FX3
requires:
  version: 0.7.229 # Version of MWGG required for this yaml to work as expected.
  game:
    Pinball FX3: 1.1.1 # Version of the world required for this yaml to work as expected.

Pinball FX3:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ################
  # Goal Options #
  ################
  goal:
    # Determines the victory condition.
    # 
    # Shiny Quarters + Final Table: Collect enough Shiny Quarters to unlock a Final Table and get a high score on it.
    # Shiny Quarter Hunt: Collect a set number of Shiny Quarters spread across the multiworld.
    shiny_quarters_final_table: 50
    shiny_quarter_hunt: 0

  shiny_quarters_total:
    # Determines how many Shiny Quarters are in the item pool.
    # 
    # This number will not be allowed to go over 2 * (number of pinball tables) and will be clamped accordingly if so.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    20: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-100: 0 # random value between 1 and 100

  shiny_quarters_required:
    # Determines how many Shiny Quarters are required to either win or unlock the final table.
    # 
    # If this number is higher than the total number of Shiny Quarters, it will be set to that number instead.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    15: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-100: 0 # random value between 1 and 100

  #########################
  # Pinball Table Options #
  #########################
  pinball_table_selection:
    # Determines which Pinball Tables can be considered for inclusion in the multiworld.
    # 
    # Set any table you don't own (or don't want to play) for Pinball FX3 to false.
    # 
    # A minimum of 6 Pinball Tables must be selected to play this implementation.
    '[Aliens vs Pinball DLC] Alien vs. Predator Pinball': true
    '[Aliens vs Pinball DLC] Alien: Isolation Pinball': true
    '[Aliens vs Pinball DLC] Aliens Pinball': true
    '[Balls of Glory Pinball DLC] American Dad! Pinball': true
    '[Balls of Glory Pinball DLC] Archer Pinball': true
    '[Balls of Glory Pinball DLC] Bob''s Burgers Pinball': true
    '[Balls of Glory Pinball DLC] Family Guy Pinball': true
    '[Bethesda Pinball DLC] DOOM Pinball': true
    '[Bethesda Pinball DLC] Fallout Pinball': true
    '[Bethesda Pinball DLC] The Elder Scrolls V: Skyrim Pinball': true
    '[Carnivals and Legends DLC] Adventure Land': true
    '[Carnivals and Legends DLC] Son of Zeus': true
    '[Core Collection DLC] Biolab': true
    '[Core Collection DLC] Pasha': true
    '[Core Collection DLC] Rome': true
    '[Core Collection DLC] Secrets of the Deep': true
    '[Free Tables] Fish Tales': true
    '[Free Tables] Sorcerer''s Lair': true
    '[Indiana Jones: The Pinball Adventure DLC] Indiana Jones: The Pinball Adventure': true
    '[Iron & Steel Pack DLC] CastleStorm': true
    '[Iron & Steel Pack DLC] Wild West Rampage': true
    '[Jurassic World Pinball DLC] Jurassic Park Pinball': true
    '[Jurassic World Pinball DLC] Jurassic Park Pinball Mayhem': true
    '[Jurassic World Pinball DLC] Jurassic World Pinball': true
    '[Marvel Pinball Avengers Chronicles DLC] Fear Itself': true
    '[Marvel Pinball Avengers Chronicles DLC] Marvel''s The Avengers': true
    '[Marvel Pinball Avengers Chronicles DLC] The Infinity Gauntlet': true
    '[Marvel Pinball Avengers Chronicles DLC] World War Hulk': true
    '[Marvel Pinball Original Pack DLC] Blade': true
    '[Marvel Pinball Original Pack DLC] Iron Man': true
    '[Marvel Pinball Original Pack DLC] Spider-Man': true
    '[Marvel Pinball Original Pack DLC] Wolverine': true
    '[Marvel Pinball Vengeance and Virtue Pack DLC] Ghost Rider': true
    '[Marvel Pinball Vengeance and Virtue Pack DLC] Moon Knight': true
    '[Marvel Pinball Vengeance and Virtue Pack DLC] Thor': true
    '[Marvel Pinball Vengeance and Virtue Pack DLC] X-Men': true
    '[Marvel Pinball: Cinematic Pack DLC] Guardians of the Galaxy': true
    '[Marvel Pinball: Cinematic Pack DLC] Marvel''s Ant-Man': true
    '[Marvel Pinball: Cinematic Pack DLC] Marvel''s Avengers: Age of Ultron': true
    '[Marvel Pinball: Heavy Hitters DLC] Civil War': true
    '[Marvel Pinball: Heavy Hitters DLC] Deadpool': true
    '[Marvel Pinball: Heavy Hitters DLC] Venom': true
    '[Marvel Pinball: Marvel Legends Pack DLC] Captain America': true
    '[Marvel Pinball: Marvel Legends Pack DLC] Doctor Strange': true
    '[Marvel Pinball: Marvel Legends Pack DLC] Fantastic Four': true
    '[Marvel''s Women of Power DLC] Marvel''s Women of Power: A-Force': true
    '[Marvel''s Women of Power DLC] Marvel''s Women of Power: Champions': true
    '[Medieval Pack DLC] Epic Quest': true
    '[Medieval Pack DLC] Excalibur': true
    '[Portal Pinball DLC] Portal': true
    '[Sci-Fi Pack DLC] Earth Defense': true
    '[Sci-Fi Pack DLC] Mars': true
    '[Sci-Fi Pack DLC] Paranormal': true
    '[Star Wars Pinball DLC] Star Wars Pinball: Boba Fett': true
    '[Star Wars Pinball DLC] Star Wars Pinball: The Clone Wars': true
    '[Star Wars Pinball DLC] Star Wars Pinball: The Empire Strikes Back': true
    '[Star Wars Pinball: Balance of the Force DLC] Star Wars Pinball: Darth Vader': true
    '[Star Wars Pinball: Balance of the Force DLC] Star Wars Pinball: Return of the Jedi': true
    '[Star Wars Pinball: Balance of the Force DLC] Star Wars Pinball: Starfighter Assault': true
    '[Star Wars Pinball: Heroes Within DLC] Star Wars Pinball: A New Hope': true
    '[Star Wars Pinball: Heroes Within DLC] Star Wars Pinball: Droids': true
    '[Star Wars Pinball: Heroes Within DLC] Star Wars Pinball: Han Solo': true
    '[Star Wars Pinball: Heroes Within DLC] Star Wars Pinball: Masters of the Force': true
    '[Star Wars Pinball: Solo DLC] Star Wars Pinball: Battle of Mimban': true
    '[Star Wars Pinball: Solo DLC] Star Wars Pinball: Calrissian Chronicles': true
    '[Star Wars Pinball: Solo DLC] Star Wars Pinball: Solo': true
    '[Star Wars Pinball: The Force Awakens Pack DLC] Star Wars Pinball: Might of the First Order': true
    '[Star Wars Pinball: The Force Awakens Pack DLC] Star Wars Pinball: The Force Awakens': true
    '[Star Wars Pinball: The Last Jedi DLC] Star Wars Pinball: Ahch-To Island': true
    '[Star Wars Pinball: The Last Jedi DLC] Star Wars Pinball: The Last Jedi': true
    '[Star Wars Pinball: Unsung Heroes DLC] Star Wars Pinball: Rebels': true
    '[Star Wars Pinball: Unsung Heroes DLC] Star Wars Pinball: Rogue One': true
    '[The Walking Dead Pinball DLC] The Walking Dead': true
    '[Universal Classics Pinball DLC] Back to the Future Pinball': true
    '[Universal Classics Pinball DLC] E.T. Pinball': true
    '[Universal Classics Pinball DLC] Jaws Pinball': true
    '[Williams Pinball: Universal Monsters Pack DLC] Monster Bash': true
    '[Williams Pinball: Universal Monsters Pack DLC] The Creature from the Black Lagoon': true
    '[Williams Pinball: Volume 1 DLC] Junk Yard': true
    '[Williams Pinball: Volume 1 DLC] Medieval Madness': true
    '[Williams Pinball: Volume 1 DLC] The Getaway: High Speed II': true
    '[Williams Pinball: Volume 2 DLC] Attack from Mars': true
    '[Williams Pinball: Volume 2 DLC] Black Rose': true
    '[Williams Pinball: Volume 2 DLC] The Party Zone': true
    '[Williams Pinball: Volume 3 DLC] Safe Cracker': true
    '[Williams Pinball: Volume 3 DLC] The Champion Pub': true
    '[Williams Pinball: Volume 3 DLC] Theatre of Magic': true
    '[Williams Pinball: Volume 4 DLC] Hurricane': true
    '[Williams Pinball: Volume 4 DLC] Red and Ted''s Road Show': true
    '[Williams Pinball: Volume 4 DLC] White Water': true
    '[Williams Pinball: Volume 5 DLC] Cirqus Voltaire': true
    '[Williams Pinball: Volume 5 DLC] No Good Gofers': true
    '[Williams Pinball: Volume 5 DLC] Tales of the Arabian Nights': true
    '[Williams Pinball: Volume 6 DLC] Dr. Dude and His Excellent Ray': true
    '[Williams Pinball: Volume 6 DLC] Funhouse': true
    '[Williams Pinball: Volume 6 DLC] Space Station': true
    '[Zen Classics DLC] El Dorado': true
    '[Zen Classics DLC] Shaman': true
    '[Zen Classics DLC] Tesla': true
    '[Zen Classics DLC] V12': true

  pinball_table_count:
    # Determines how many Pinball Tables will be picked from your table selection for inclusion in the multiworld.
    # 
    # If this number is higher than the size of your Pinball Table selection, it will be set to that number instead.
    # 
    # Note: Setting this value below 10 could extremely rarely lead to generation failures when paired with other
    #       restrictive options.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 6
    # Maximum value is 100
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-6-100: 0 # random value between 6 and 100

  ########################
  # Target Score Options #
  ########################
  exclude_high_tier_target_scores:
    # If enabled, locations for High-Tier Target Scores will not be created when generating the multiworld.
    # If your goal includes a final table, the Target Score will shift to the Mid-Tier Target Score instead.
    # 
    # Disabling this option will add more locations, but will also place additional player skill expectations on you.
    'false': 0
    'true': 50

  target_score_requirement_mode:
    # Determines how Target Score requirements are set.
    # 
    # Same for All Tables: A single percentage will be applied to the Target Scores of all tables
    # Random per Table: Each table will have a random percentage applied to its Target Scores
    same_for_all_tables: 50
    random_per_table: 0

  target_score_requirement_percentage:
    # Determines the percentage to apply Target Scores. You will not unlock location checks until
    # you reach or exceed the Target Scores on a given table.
    # 
    # This only applies to Single-Player mode play.
    # 
    # When the requirement mode is set to random per table, the specified percentage will act as the maximum possible.
    # 
    # The Pinball FX3 Archipelago client will display the expected scores for each table under the Pinball FX3 tab.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 50
    # Maximum value is 200
    100: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-50-200: 0 # random value between 50 and 200

  ##########################
  # Challenge Star Options #
  ##########################
  progressive_challenge_access:
    # If enabled, Challenge Access items will unlock Challenge tiers in a progressive manner, meaning you will gain
    # access to Low -> Mid -> High-Tier sequentially for each Challenge type. This should smooth the difficulty curve,
    # allowing you to collect some useful items by the time you reach High-Tier Challenges.
    # 
    # For a more challenging / chaotic experience, disable this option. Expect to possibly have to obtain High-Tier
    # Challenge stars very early on, before Low or Mid-Tier stars and sometimes without any useful items helping you out.
    'false': 0
    'true': 50

  exclude_high_tier_challenge_stars:
    # Determines whether High-Tier Challenge Stars are excluded from the multiworld and under what conditions.
    # 
    # Exclude All: No High-Tier Challenge Star locations will be created.
    # Exclude Only 1 Ball: High-Tier Challenge Star locations for 1-Ball challenges will not be created.
    # Do Not Exclude: All High-Tier Challenge Star locations will be created.
    # 
    # Including High-Tier Challenge Stars will add more locations, but will also place additional player skill
    # expectations on you.
    exclude_all: 50
    exclude_only_1_ball: 0
    do_not_exclude: 0

  challenge_star_requirement_mode:
    # Determines how Challenge Star requirements are set.
    # 
    # Same for All Tables: A single Star requirement will be applied to all tables for each challenge tier
    # Random per Table: Each table will have random Star requirements for each challenge tier
    same_for_all_tables: 50
    random_per_table: 0

  challenge_low_tier_star_requirement:
    # Determines how many Stars you need to obtain to check low-tier challenge locations.
    # 
    # When the requirement mode is set to random per table, the specified number will act as the maximum possible.
    # 
    # The Pinball FX3 Archipelago client will display the Star requirements for each table under the Pinball FX3 tab.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 5
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-5: 0 # random value between 1 and 5

  challenge_mid_tier_star_requirement:
    # Determines how many Stars you need to obtain to check mid-tier challenge locations.
    # 
    # When the requirement mode is set to random per table, the specified number will act as the maximum possible.
    # 
    # The Pinball FX3 Archipelago client will display the Star requirements for each table under the Pinball FX3 tab.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 6
    # Maximum value is 10
    8: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-6-10: 0 # random value between 6 and 10

  challenge_high_tier_star_requirement:
    # Determines how many Stars you need to obtain to check high-tier challenge locations.
    # 
    # When the requirement mode is set to random per table, the specified number will act as the maximum possible.
    # 
    # The Pinball FX3 Archipelago client will display the Star requirements for each table under the Pinball FX3 tab.
    # 
    # WARNING: Getting more than 11 Stars can be extremely difficult on certain challenges. It is recommended to start
    #          at 11 and increase only if you are confident you can handle it.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 11
    # Maximum value is 15
    11: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-11-15: 0 # random value between 11 and 15

  ##################
  # Sanity Options #
  ##################
  starsanity:
    # If enabled, every Star obtained below the requirement of each tier will also count as a location check.
    # 
    # Examples: If the Star requirements for a table are 3 / 8 / 11, you will get additonal location checks for
    #           1 / 2 / 6 / 7 Stars as well.
    # 
    #           If the Star requirements for a table are 4 / 9 / 12, you will get additional location checks for
    #           1 / 2 / 3 / 6 / 7 / 8 / 11 Stars as well.
    # 
    # WARNING: This will add a proportionally large amount of filler / useful items to the pool.
    'false': 50
    'true': 0

  #######################
  # Useful Item Options #
  #######################
  useful_item_percentage:
    # Determines what percentage of filler items will get converted to useful items.
    # 
    # Useful items are: Target Score Discount, Target Score Multiplier, Star Requirement Discount
    # 
    # These will make the game slightly easier, but are also table-specific for balance purposes.
    # 
    # The Pinball FX3 Archipelago client will display the useful items assigned to each table under the Pinball FX3 tab.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    50: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  useful_item_weights:
    # Determines the relative weights of each useful item type when a useful item replaces a filler item.
    # 
    # Each weight needs to be at least 1.
    Score Multiplier: 1
    Star Requirement Discount: 1
    Target Score Discount: 1

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
